home *** CD-ROM | disk | FTP | other *** search
/ Megadoom II / MEGADOOM II - iso.7z / MEGADOOM II.ISO / doom / editors / map / dmpsmu / readme < prev    next >
Text File  |  1994-10-31  |  10KB  |  231 lines
  1. ______   _____   _____  __    ___   DMPSMU   ___    __   ___   ______    ____ 
  2. | __  \ |  _  | |  _  | | \  /  | PostScript |  \  / |  / _ \  | ___ \  /  __|
  3. | | \ | | | | | | | | | || \/ . | %%  %%  !! | . \/ || / /_\ \ | |_/ / {  {_
  4. | | / | | \_/ | | \_/ | ||\  /| | %% %    !! | |\  /|| |  _  | |  __/   \__ \
  5. | |/ /   \   /   \   /  || \/ | |   % %%  !! | | \/ || | | | | | |     __  \ \
  6. | ' /     \_/     \_/   \|    | | %%  %%  !! | |    |/ \_| |_/ \_|     \ \_/ /
  7. |__/                          \_|  Utility.  |_/                        \___/
  8.                                      v2.0
  9.                      Frans P. de Vries (fpv@xymph.iaf.nl)
  10.                                October 31, 1994
  11.  
  12.  
  13. This is DMPSMU, the DOOM PostScript Maps Utility package. It provides DMPSMU,
  14. an interactive utility to generate PostScript maps of levels in DOOM / DOOM ][,
  15. the 3D action games by id Software, and DMPSMAP, a command-line based sidekick.
  16. They offer everything you ever wanted from a DOOM map generator, and more!
  17. The following features are presented:
  18.  
  19.   * detailed control over layout and appearance of the page(s):
  20.     Supports European/American paper sizes, Portrait/Landscape orientation,
  21.     printing of a border, the level name (possibly user defined) and a legend
  22.     box, and auto scaling depending on the size and orientation of the map
  23.     versus the paper size as well as the map's shape versus the presence of
  24.     level name and/or legend box.
  25.  
  26.   * multi-page capability, printing on 2 or 4 normal pages:
  27.     Creates one PostScript file in A4/A3/A2 or Letter/Tabloid/double_Tabloid
  28.     size, from which individual A4/Letter size pages can be printed using
  29.     shell script utilities.
  30.  
  31.   * detailed control over which Things will be printed:
  32.     Distinguishes between starting points, teleport exits, small bonuses,
  33.     weapons, enhancements, enemies, barrels and decorations, as well as
  34.     their multi-player and difficulty-setting properties.
  35.  
  36.   * fading LineDefs that are secret or part of a secret Sector:
  37.     Prints grey lines for secret LineDefs or LineDefs belonging to a secret
  38.     Sector. For really seeing where the secrets are, the following feature
  39.     is even better though.
  40.  
  41.   * shading secret Sector areas, but not their inner Sectors:
  42.     Prints grey areas for secret Sectors but excludes any inner Sectors like
  43.     massive pillars. Truly visualizes where you must have been to get a 100%
  44.     Secret score.
  45.  
  46.   * linking teleporters and their exits by faint lines:
  47.     Shows where you're teleported by linking the midpoint of a teleporting
  48.     LineDef to the corresponding teleport exit. Now you never have to feel
  49.     tele-lost again!
  50.  
  51.   * support for DOOM ][ WAD files:
  52.     Recognizes the new level numbering, level names, things, monsters and
  53.     monster-only teleporters.
  54.  
  55. You have extensive control over which features are used when printing your
  56. maps by setting and clearing one or more of 16 print flags, boosting a
  57. staggering 48K (no, not 64K ;) possibilities in outputting your maps!  In
  58. practice you will need to use only a few flags though, as most flags are set
  59. to defaults which you'll like to use all the time.
  60.  
  61. In addition, since the interactive utility DMPSMU is derived from DEU, the
  62. Doom Editor Utility, and retains from this tool all functions that have a
  63. read-only effect on the DOOM WAD files, it offers examination but not
  64. modification of these files under Unix and has a new function to display a
  65. level's vital statistics.
  66.  
  67. --
  68. Frans P. de Vries (FPV) | Snail: de Wilmskamp 83, 7552 GW Hengelo, Netherlands
  69. Email: fpv@xymph.iaf.nl | Voice: +31 (74) 916 034 | DOOM][+GUS1M == ImMeRsIoN!
  70.  
  71.  
  72.  
  73. INSTALL
  74. =======
  75.  
  76. Installation of the package is straight-forward. Unzip the package (which
  77. you have probably done already to read this file ;)  preferably recursively
  78. (default in Info-UNZIP, requires '-d' option to PKUNZIP). Go into the source
  79. directory and check the Makefile for the C compiler and its flag and include
  80. definitions. Set CC to your ANSI C compiler, CFLAGS & LDFLAGS as desired and
  81. if necessary, INCLUDES to your directory with ANSI C header files. If you're
  82. on a big endian system, leave DEFINES as is, otherwise select the empty one.
  83. Then type 'make'.
  84.  
  85. Find a way to copy your DOOM{1,2}.WAD file to your Unix system and copy the
  86. shell scripts 'all*.sh' and 'dmps*.sh' as well as the just 'made' executables
  87. into the same directory for easy access to the WAD file. And presto, you're
  88. all set to _truly_ paper the wall with DOOM and DOOM ][ PostScript Maps! :-)
  89.  
  90.  
  91. RANDOM NOTES
  92. ============
  93.  
  94. The following DOOM levels are best printed in Portrait:
  95.   E1M8, E2M2, E2M6, E2M8, E3M1, E3M2, E3M6, E3M7, E3M8, E3M9
  96. The remaining DOOM levels are best printed in Landscape:
  97.   E1M1, E1M2, E1M3, E1M4, E1M5, E1M6, E1M7, E1M9,
  98.   E2M1, E2M3, E2M4, E2M5, E2M7, E2M9, E3M3, E3M4, E3M5
  99. The script 'allmaps.sh' prints the DOOM maps accordingly.
  100.  
  101. The following DOOM ][ levels are best printed in Portrait:
  102.   MAP01, MAP02, MAP10, MAP12, MAP13, MAP15, MAP16, MAP17, MAP19,
  103.   MAP20, MAP23, MAP25, MAP27, MAP28, MAP30, MAP32
  104. The remaining DOOM ][ levels are best printed in Landscape:
  105.   MAP03, MAP04, MAP05, MAP06, MAP07, MAP08, MAP09, MAP11, MAP14,
  106.   MAP18, MAP21, MAP22, MAP24, MAP26, MAP29, MAP31
  107. The script 'allmaps2.sh' prints the DOOM ][ maps accordingly.
  108.  
  109. A few minor flaws in the maps of DOOM v1.2/v1.666 show up on the maps:
  110. E2M1: has a stray teleport exit Thing in sector 54 in the north-west, at
  111.       the end of the narrow corridor.
  112. E2M2: has no 'impassible' bits set on the LineDefs surrounding sector 32 in
  113.       the south-west, around the secret plasma gun.
  114. E3M3: has no 'impassible' bit set on the northern LineDef of sector 165 in
  115.       the north-east, north of the pit with the two demons.
  116.  
  117. Another few minor flaws in the maps of DOOM ][ v1.666 were also revealed:
  118. MAP03: has a stray teleport exit Thing in sector 1 in front of the secret area.
  119. MAP06: has a stray teleport exit Thing in sector 120 up on the ledge in the
  120.        south-east corner of the 'crusher hall' (this sector is actually tagged
  121.        the same as the lower numbered sector 72 to which teleporting happens).
  122. MAP11: has a stray teleport exit Thing in sector 119 before the red door.
  123. MAP12: has LineDef 113 before the alcove at the end of the "falling" passage
  124.        after the green armor marked as teleporting to a sector tagged 13,
  125.        which doesn't exits; the teleport line thus does nothing.
  126. MAP18: has no 'impassible' bits set on LineDefs 717 & 725 east and west of the
  127.        exit door.
  128. MAP22: has no 'impassible' bits set on LineDefs 518 & 509 north and south just
  129.        outside the alcove west of the central room.
  130. MAP23: has 'secret' LineDefs on the pillar in the north-west bended passage,
  131.        while that pillar really isn't all that secret :)
  132. MAP30: has a stray LineDef (55) in the east, visible even on the Automap.
  133. Note : all above LineDef and Sector numbers verified with a quickly hacked
  134.        (<2 hours;) incomplete port of DEU 5.21 GCC Linux to DOOM ][. Of course
  135.        I had a headstart from porting DMPSMU :)
  136.  
  137. Anyone know the proper name for double_Tabloid?  Please email me.
  138. Anyone know a more complete list of big/little endian systems? Ditto.
  139. The same goes for ideas for new features and other improvements.
  140. And I especially welcome a better algorithm for FindTeleExit in 'print.c'.
  141.  
  142. If you want different default settings for the print flags, then change them
  143. in 'source/print.c' and remake.
  144.  
  145. Best results are of course produced by printing the PostScript files on a
  146. better than 300 dpi printer <duh;>
  147.  
  148. The delay since finishing the coding/testing/documenting in August was due to
  149. the need for setting up a Linux/DOS box and Internet access at home first,
  150. and then to add DOOM ][ support and other new features. Sorry to keep you all
  151. deprived of DMPSMU for so long ;-)
  152.  
  153.  
  154. BUGS
  155. ====
  156.  
  157. -   there still are some teleport mislinkings in DOOM ][ levels MAP13 & MAP16.
  158.     (see the remark about the algorithm above)
  159.  
  160.  
  161. TODO
  162. ====
  163.  
  164. -   port back to PC/DJGPP-GO32 and add DOS-runnable executable for DMPSMAP.
  165.  
  166.  
  167. CREDITS
  168. =======
  169.  
  170. My thanks go to the following people for their work:
  171.  
  172. -   the folks at id Software for creating such a fabulous game!
  173.  
  174. -   Brendon J. Wyber and Raphaδl Quinet (and everyone working with them)
  175.     for creating the DEU editor and Per Allansson and Per Kofod for porting
  176.     it to a more sane C compiler ;)
  177.     And: if they hadn't released the source with it, this utility wouldn't
  178.     exist (or at least not in the same form :-)
  179.  
  180. -   Matt Fell for the indispensable DOOM Specs (distributed by Hank Leukart),
  181.     especially for the v1.666 preview!
  182.  
  183. -   James Bonfield for showing (in his early v1.1 hack at this PostScript
  184.     thingy) how to solve the big/little endian problem.
  185.  
  186.  
  187. RESTRICTIONS
  188. ============
  189.  
  190.     The source in the DMPSMU package should not be used to create a utility
  191.     that can modify the DOOM WAD file; you're better off with DEU v5.21 GCC
  192.     anyway. It is illegal to use the source in this package to modify the
  193.     shareware version of DOOM.
  194.  
  195.     If you derive another utility from this package, name it something else
  196.     and give some credit to the original author(s).
  197.  
  198.     If you distribute the DMPSMU package, please distribute the original ZIP
  199.     file unmodified and under the same name.
  200.  
  201.  
  202. TRADEMARKS
  203. ==========
  204.  
  205.     DOOM and DOOM ][ are trademarks of id Software Incorporated.
  206.     PostScript is a trademark of Adobe Systems Incorporated.
  207.  
  208.     DEU is copyrighted by Brendon J. Wyber and Raphaδl Quinet.
  209.  
  210.  
  211. COPYLEFT
  212. ========
  213.  
  214.     DooM PostScript Maps Utility (DMPSMU & DMPSMAP)
  215.     Copyright (C) 1994  Frans P. de Vries, Hengelo, The Netherlands
  216.  
  217.     This program is free software; you can redistribute it and/or modify
  218.     it under the terms of the GNU General Public License as published by
  219.     the Free Software Foundation; either version 2 of the License, or
  220.     (at your option) any later version.
  221.  
  222.     This program is distributed in the hope that it will be useful,
  223.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  224.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  225.     GNU General Public License for more details.
  226.  
  227.     You should have received a copy of the GNU General Public License
  228.     along with this program; if not, write to the Free Software
  229.     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  230.  
  231.